dbt Cloud CLIとSQLFluffとGitHub Actionsを用いて、プルリクエスト発行時に自動フォーマッティングしてみた

[sqlfluff]
templater = dbt
# This change (from jinja to dbt templater) will make linting slower
# because linting will first compile dbt code into data warehouse code.
runaway_limit = 10
max_line_length = 80
indent_unit = space

[sqlfluff:indentation]
tab_space_size = 4

[sqlfluff:layout:type:comma]
spacing_before = touch
line_position = trailing

[sqlfluff:rules:capitalisation.keywords] 
capitalisation_policy = lower

[sqlfluff:rules:aliasing.table]
aliasing = explicit

[sqlfluff:rules:aliasing.column]
aliasing = explicit

[sqlfluff:rules:aliasing.expression]
allow_scalar = False

[sqlfluff:rules:capitalisation.identifiers]
extended_capitalisation_policy = lower

[sqlfluff:rules:capitalisation.functions]
capitalisation_policy = lower

[sqlfluff:rules:capitalisation.literals]
capitalisation_policy = lower

[sqlfluff:rules:ambiguous.column_references]  # Number in group by
group_by_and_order_by_style = implicit

dbt_packages/
macros/
seeds/
target/

name: SQLFluff Formatting

on:
  pull_request:
    types: [opened, synchronize] # プルリクエストがオープン、更新された場合にトリガー

jobs:
  formatter:
    name: formatter
    runs-on: ubuntu-latest # Ubuntu Linux 上で実行
    permissions:
      contents: write # コンテンツに対する書き込み権限を設定
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4 # GitHubリポジトリからコードをチェックアウト
        with:
          ref: ${{ github.head_ref }} # GitHubヘッドリファレンスを指定。開発をしたプルリクエスト元のブランチが参照される
      - name: Set up Python
        uses: actions/setup-python@v4 # Python環境のセットアップ
        with:
          python-version: "3.12" # 使用するPythonバージョンを指定
      - name: Authenticate using service account
        run: |
          mkdir -p ~/.dbt # .dbtディレクトリを作成
          echo "$KEYFILE" > ~/.dbt/dbt_cloud.yml # secretとして登録したdbt_cloud.ymlを元に、ランナーでもdbt_cloud.ymlを作成
        shell: bash
        env:
          KEYFILE: ${{secrets.DBT_CLOUD_CLI_CONFIG_YAML}}
      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip # pipをアップグレード
          pip install dbt --no-cache-dir # dbt Cloud CLIをインストール
      - name: SQLFluff Fix # sqlfluffを使用してコードをフォーマッティング
        run: dbt sqlfluff fix ./models/* --dialect snowflake # sqlfluffをmodelsフォルダ配下の.sqlファイルに適用
      - name: Auto Commit
        uses: stefanzweifel/git-auto-commit-action@v5 # 自動コミットアクションを使用
        with:
          commit_message: Apply Code Formatter(SQLFluff) # コミットメッセージを指定